// 版权所有2009 Go作者。保留所有权利。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

// 包ascii85实现了在btoa工具和Adobe的PostScript和PDF文档格式中使用的ascii85数据编码
// 。
package ascii85

import (
	"io"
	"strconv"
)

/*
 * Encoder
 */

// Encode将src编码为dst的最大MaxEncodedLen（len（src））
// 字节，返回实际写入的字节数。
// 
// 该编码处理4字节块，对最后一个片段使用特殊编码
// 因此Encode不适用于大数据流的单个块。改用NewEncoder（）。
// 
// 通常，ASCI85编码的数据被包装在<~和~>符号中。
// Encode不添加这些。
func Encode(dst, src []byte) int {
	if len(src) == 0 {
		return 0
	}

	n := 0
	for len(src) > 0 {
		dst[0] = 0
		dst[1] = 0
		dst[2] = 0
		dst[3] = 0
		dst[4] = 0

		// 将4个字节解压到uint32中，重新打包到85个5字节的基中。
		var v uint32
		switch len(src) {
		default:
			v |= uint32(src[3])
			fallthrough
		case 3:
			v |= uint32(src[2]) << 8
			fallthrough
		case 2:
			v |= uint32(src[1]) << 16
			fallthrough
		case 1:
			v |= uint32(src[0]) << 24
		}

		// 特殊情况：零（！！！！！）缩写为z.
		if v == 0 && len(src) >= 4 {
			dst[0] = 'z'
			dst = dst[1:]
			src = src[4:]
			n++
			continue
		}

		// 否则，从！开始的5位85进制数字！。
		for i := 4; i >= 0; i-- {
			dst[i] = '!' + byte(v%85)
			v /= 85
		}

		// 如果src很短，则丢弃低目标字节。
		m := 5
		if len(src) < 4 {
			m -= 4 - len(src)
			src = nil
		} else {
			src = src[4:]
		}
		dst = dst[m:]
		n += m
	}
	return n
}

// MaxEncodedLen返回n个源字节的编码的最大长度。
func MaxEncodedLen(n int) int { return (n + 3) / 4 * 5 }

// NewEncoder返回一个新的ASCI85流编码器。写入
// 返回的写入程序将被编码，然后写入w。
// ASCI85编码在32位块中运行；完成
// 写入后，调用方必须关闭返回的编码器以刷新任何
// 尾部部分块。
func NewEncoder(w io.Writer) io.WriteCloser { return &encoder{w: w} }

type encoder struct {
	err  error
	w    io.Writer
	buf  [4]byte    // 等待编码的缓冲数据
	nbuf int        // buf中的字节数
	out  [1024]byte // 输出缓冲区
}

func (e *encoder) Write(p []byte) (n int, err error) {
	if e.err != nil {
		return 0, e.err
	}

	// 前导边缘。
	if e.nbuf > 0 {
		var i int
		for i = 0; i < len(p) && e.nbuf < 4; i++ {
			e.buf[e.nbuf] = p[i]
			e.nbuf++
		}
		n += i
		p = p[i:]
		if e.nbuf < 4 {
			return
		}
		nout := Encode(e.out[0:], e.buf[0:])
		if _, e.err = e.w.Write(e.out[0:nout]); e.err != nil {
			return n, e.err
		}
		e.nbuf = 0
	}

	// 内部大块。
	for len(p) >= 4 {
		nn := len(e.out) / 5 * 4
		if nn > len(p) {
			nn = len(p)
		}
		nn -= nn % 4
		if nn > 0 {
			nout := Encode(e.out[0:], p[0:nn])
			if _, e.err = e.w.Write(e.out[0:nout]); e.err != nil {
				return n, e.err
			}
		}
		n += nn
		p = p[nn:]
	}

	// 尾随边缘。
	copy(e.buf[:], p)
	e.nbuf = len(p)
	n += len(p)
	return
}

// Close刷新编码器的任何挂起输出。
// 调用Close后调用Write是一个错误。
func (e *encoder) Close() error {
	// 如果缓冲区中还有剩余内容，请将其清除
	if e.err == nil && e.nbuf > 0 {
		nout := Encode(e.out[0:], e.buf[0:e.nbuf])
		e.nbuf = 0
		_, e.err = e.w.Write(e.out[0:nout])
	}
	return e.err
}

/*
 * Decoder
 */

type CorruptInputError int64

func (e CorruptInputError) Error() string {
	return "illegal ascii85 data at input byte " + strconv.FormatInt(int64(e), 10)
}

// 解码将src解码到dst，返回写入dst的字节数
// 和从src消耗的字节数。
// 如果src包含无效的ASCI85数据，Decode将返回
// 成功写入的字节数和损坏计算机。
// 解码忽略src中的空格和控制字符。
// 通常，ASCI85编码的数据被包装在<~和~>符号中。
// Decode希望这些内容已被调用方删除。
// 
// 如果flush为真，Decode假设src代表输入流的
// 结束，并完全处理它，而不是等待另一个32位块的完成。
// 
// 新解码器包装io。读卡器接口围绕解码。
// 
func Decode(dst, src []byte, flush bool) (ndst, nsrc int, err error) {
	var v uint32
	var nb int
	for i, b := range src {
		if len(dst)-ndst < 4 {
			return
		}
		switch {
		case b <= ' ':
			continue
		case b == 'z' && nb == 0:
			nb = 5
			v = 0
		case '!' <= b && b <= 'u':
			v = v*85 + uint32(b-'!')
			nb++
		default:
			return 0, 0, CorruptInputError(i)
		}
		if nb == 5 {
			nsrc = i + 1
			dst[ndst] = byte(v >> 24)
			dst[ndst+1] = byte(v >> 16)
			dst[ndst+2] = byte(v >> 8)
			dst[ndst+3] = byte(v)
			ndst += 4
			nb = 0
			v = 0
		}
	}
	if flush {
		nsrc = len(src)
		if nb > 0 {
			// 最后一个片段中的输出字节数
			// 是剩余的输入字节数-1:
			// 额外的字节提供足够的位来覆盖
			// 块的编码效率低下。
			if nb == 1 {
				return 0, 0, CorruptInputError(len(src))
			}
			for i := nb; i < 5; i++ {
				// 短编码截断了输出值。
				// 我们必须假设最坏情况下的值（数字84）
				// 以确保顶部的位是正确的。
				v = v*85 + 84
			}
			for i := 0; i < nb-1; i++ {
				dst[ndst] = byte(v >> 24)
				v <<= 8
				ndst++
			}
		}
	}
	return
}

// NewDecoder构造了一个新的ASCI85流解码器。
func NewDecoder(r io.Reader) io.Reader { return &decoder{r: r} }

type decoder struct {
	err     error
	readErr error
	r       io.Reader
	buf     [1024]byte // 剩余输入
	nbuf    int
	out     []byte // 剩余解码输出
	outbuf  [1024]byte
}

func (d *decoder) Read(p []byte) (n int, err error) {
	if len(p) == 0 {
		return 0, nil
	}
	if d.err != nil {
		return 0, d.err
	}

	for {
		// 复制上次解码的剩余输出。
		if len(d.out) > 0 {
			n = copy(p, d.out)
			d.out = d.out[n:]
			return
		}

		// 解码上次读取的剩余输入。
		var nn, nsrc, ndst int
		if d.nbuf > 0 {
			ndst, nsrc, d.err = Decode(d.outbuf[0:], d.buf[0:d.nbuf], d.readErr != nil)
			if ndst > 0 {
				d.out = d.outbuf[0:ndst]
				d.nbuf = copy(d.buf[0:], d.buf[nsrc:d.nbuf])
				continue // 复制并返回
			}
			if ndst == 0 && d.err == nil {
				// 特殊情况：输入缓冲区大部分填充了非数据字节。
				// 过滤掉这些字节，为更多输入腾出空间。
				off := 0
				for i := 0; i < d.nbuf; i++ {
					if d.buf[i] > ' ' {
						d.buf[off] = d.buf[i]
						off++
					}
				}
				d.nbuf = off
			}
		}

		// 输入不足，解码输出不足。检查错误。
		if d.err != nil {
			return 0, d.err
		}
		if d.readErr != nil {
			d.err = d.readErr
			return 0, d.err
		}

		// 读取更多数据。
		nn, d.readErr = d.r.Read(d.buf[d.nbuf:])
		d.nbuf += nn
	}
}
